hapi_rs/parameter/
access.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
use super::*;

use std::ffi::CString;

pub use crate::ffi::enums::ParmType;

use crate::errors::Result;

impl IntParameter {
    /// Set parameter value at index.
    pub fn set(&self, index: i32, value: i32) -> Result<()> {
        let session = &self.0.info.1;
        debug_assert!(self.0.node.is_valid(session)?);
        let name = self.c_name()?;
        crate::ffi::set_parm_int_value(self.0.node, session, &name, index, value)
    }

    /// Get parameter value at index.
    pub fn get(&self, index: i32) -> Result<i32> {
        let session = &self.0.info.1;
        debug_assert!(self.0.node.is_valid(session)?);
        let name = self.c_name()?;
        crate::ffi::get_parm_int_value(self.0.node, session, &name, index)
    }

    /// Set all parameter tuple values
    pub fn set_array(&self, val: impl AsRef<[i32]>) -> Result<()> {
        let session = &self.0.info.1;
        debug_assert!(self.0.node.is_valid(session)?);
        crate::ffi::set_parm_int_values(
            self.0.node,
            session,
            self.0.info.int_values_index(),
            self.0.info.size(),
            val.as_ref(),
        )
    }

    /// Set parameter tuple values
    pub fn get_array(&self) -> Result<Vec<i32>> {
        let session = &self.0.info.1;
        debug_assert!(self.0.node.is_valid(session)?);
        crate::ffi::get_parm_int_values(
            self.0.node,
            session,
            self.0.info.int_values_index(),
            self.0.info.size(),
        )
    }

    /// Emulates a button press action
    pub fn press_button(&self) -> Result<()> {
        if !matches!(self.0.info.parm_type(), ParmType::Button) {
            log::warn!("Parm {} not a Button type", self.0.info.name()?);
        }
        self.set(0, 1)
    }
}

impl FloatParameter {
    /// Set parameter value at index.
    pub fn set(&self, index: i32, value: f32) -> Result<()> {
        let session = &self.0.info.1;
        debug_assert!(self.0.node.is_valid(session)?);
        let name = self.c_name()?;
        crate::ffi::set_parm_float_value(self.0.node, session, &name, index, value)
    }

    /// Get parameter value at index.
    pub fn get(&self, index: i32) -> Result<f32> {
        let session = &self.0.info.1;
        debug_assert!(self.0.node.is_valid(session)?);
        let name = self.c_name()?;
        crate::ffi::get_parm_float_value(self.0.node, session, &name, index)
    }

    /// Set all parameter tuple values
    pub fn set_array(&self, values: impl AsRef<[f32]>) -> Result<()> {
        let session = &self.0.info.1;
        debug_assert!(self.0.node.is_valid(session)?);
        let mut size = self.0.info.size() as usize;
        let values = values.as_ref();
        match values.len() {
            len if len > size => {
                log::warn!("Array length is greater than parm length: {size}");
                size = values.len().min(size);
            }
            len if len == 0 => {
                log::warn!("Parameter::set_array got empty array");
                return Ok(());
            }
            _ => {}
        }
        crate::ffi::set_parm_float_values(
            self.0.node,
            session,
            self.0.info.float_values_index(),
            size as i32,
            values,
        )
    }

    /// Get all parameter tuple values
    pub fn get_array(&self) -> Result<Vec<f32>> {
        let session = &self.0.info.1;
        debug_assert!(self.0.node.is_valid(session)?);
        crate::ffi::get_parm_float_values(
            self.0.node,
            session,
            self.0.info.float_values_index(),
            self.0.info.size(),
        )
    }
}

impl StringParameter {
    /// Set parameter value at index.
    pub fn set(&self, index: i32, value: impl AsRef<str>) -> Result<()> {
        let session = &self.0.info.1;
        debug_assert!(self.0.node.is_valid(session)?);
        let value = CString::new(value.as_ref())?;
        crate::ffi::set_parm_string_value(self.0.node, session, self.0.info.id(), index, &value)
    }

    /// Get parameter value at index.
    pub fn get(&self, index: i32) -> Result<String> {
        let session = &self.0.info.1;
        debug_assert!(self.0.node.is_valid(session)?);
        let name = self.c_name()?;
        crate::ffi::get_parm_string_value(self.0.node, session, &name, index)
    }
    /// Set all parameter tuple values
    pub fn set_array<T: AsRef<str>>(&self, val: impl AsRef<[T]>) -> Result<()> {
        let session = &self.0.info.1;
        debug_assert!(self.0.node.is_valid(session)?);
        let values = val
            .as_ref()
            .iter()
            .map(|s| CString::new(s.as_ref()))
            .collect::<std::result::Result<Vec<_>, _>>()?;
        crate::ffi::set_parm_string_values(self.0.node, session, self.0.info.id(), &values)
    }

    /// Get all parameter tuple values
    pub fn get_array(&self) -> Result<Vec<String>> {
        let session = &self.0.info.1;
        debug_assert!(self.0.node.is_valid(session)?);
        crate::ffi::get_parm_string_values(
            self.0.node,
            session,
            self.0.info.string_values_index(),
            self.0.info.size(),
        )
        .map(|array| array.into())
    }

    /// Save/Download a file referenced in this parameter to a given file.
    /// `filename` must include the desired extension to work properly.
    pub fn save_parm_file(&self, destination_dir: &std::path::Path, filename: &str) -> Result<()> {
        log::debug!(
            "Saving parameter file to: {:?}/{}",
            destination_dir,
            filename
        );
        let dest_dir = crate::utils::path_to_cstring(destination_dir)?;
        let dest_file = CString::new(filename)?;
        crate::ffi::get_file_parm(
            &self.0.info.1,
            self.0.node,
            &self.c_name()?,
            &dest_dir,
            &dest_file,
        )
    }

    /// If parameter is a `ParmType::Node` type, set it to reference another node
    pub fn set_value_as_node(&self, value: impl AsRef<NodeHandle>) -> Result<()> {
        debug_assert!(self.0.node.is_valid(self.session())?);
        if self.0.info.parm_type() == ParmType::Node {
            crate::ffi::set_parm_node_value(
                self.session(),
                self.0.node,
                &self.c_name()?,
                *value.as_ref(),
            )
        } else {
            Ok(())
        }
    }
    /// Return a handle to a node if the parameter is of type `ParmType::Node`
    pub fn get_value_as_node(&self) -> Result<Option<NodeHandle>> {
        debug_assert!(self.0.node.is_valid(self.session())?);
        if self.0.info.parm_type() == ParmType::Node {
            crate::ffi::get_parm_node_value(self.session(), self.0.node, &self.c_name()?)
        } else {
            Ok(None)
        }
    }
}