# VectorSampler

class VectorSampler : public HPS::Sampler

  A VectorSampler is a type of Sampler which holds Keyframe which specify values as Vectors. For example, if a Channel is setup to animate the value of the camera’s up vector, the values assumed by the up vector will have to be specified as Vectors, and therefore be held in VectorKeyframes, which will be collected in a VectorSampler.

  Public Functions

  void AddKeyframe(VectorKeyframe const &in_keyframe)

    Adds the provided keyframe to this Sampler. The provided keyframe will be automatically sorted into the Sampler. If the sampler already contains a keyframe targeting the same timer tick as in_keyframe, it will be replaced

    Parameters:

      in_keyframe – the keyframe to add to this Sampler

  void AddKeyframes(size_t in_count, VectorKeyframe const in_keyframes[])

    Adds the provided keyframes to this Sampler. The provided keyframes will be automatically sorted and validated. Adding a key frame will replace already existing keyframes that target the same timer tick. Each element in in_keyframe should target a different timer tick. Not complying with the restriction specified above will result in an exception of type HPS::InvalidSpecificationException being thrown.

    Parameters:

      - in_count – the number of keyframes in the in_keyframes array

      - in_keyframes – the array of keyframes to add to this Sampler

  void AddKeyframes(VectorKeyframeArray const &in_keyframes)

    Adds the provided keyframes to this Sampler. The provided keyframes will be automatically sorted and validated. Adding a key frame will replace already existing keyframes that target the same timer tick. Each element in in_keyframe should target a different timer tick. Not complying with the restriction specified above will result in an exception of type HPS::InvalidSpecificationException being thrown.

    Parameters:

      in_keyframes – the array of keyframes to add to this Sampler

  VectorSplineControlValuesArray const &GetControlValues() const

    Returns the control values this Sampler is set to use during Spline interpolation of keyframe values.

    Returns:

      An array of control point values previously specified to SetControlValues.

  VectorKeyframeArray const &GetKeyframes() const

    Returns the keyframes contained in this Sampler. Because keyframes are sorted as they are added to the Sampler, the order of keyframes returned might not match the order in which they were inserted in this Sampler.

    Returns:

      An array of keyframes contained in this Sampler.

  inline virtual HPS::Type ObjectType() const

    This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

    Returns:

      The declared type of the object in question, which may differ from the true, underlying type.

  void SetControlValues(VectorSplineControlValuesArray const &in_control_points)

    Sets control values used during Spline interpolation of keyframe values. If this Sampler is not set to use Spline interpolation these values will be ignored during playback.

    Parameters:

      in_control_points – The control points to use for interpolation. When executing playback this array must be equal in size to the keyframe array associated with this Sampler.

  void SetKeyframes(size_t in_count, VectorKeyframe const in_keyframes[])

    Replaces the keyframes on this Sampler with those provided The provided keyframes will be automatically sorted and validated. Each element in in_keyframe should target a different timer tick. Not complying with the restriction specified above will result in an exception of type HPS::InvalidSpecificationException being thrown.

    Parameters:

      - in_count – the number of keyframes in the in_keyframes array

      - in_keyframes – the array of keyframes to add to this Sampler

  void SetKeyframes(VectorKeyframeArray const &in_keyframes)

    Replaces the keyframes on this Sampler with those provided The provided keyframes will be automatically sorted and validated. Each element in in_keyframe should target a different timer tick. Not complying with the restriction specified above will result in an exception of type HPS::InvalidSpecificationException being thrown.

    Parameters:

      in_keyframes – the array of keyframes to add to this Sampler

  VectorSampler()
  explicit VectorSampler(Sampler const &in_that)
  VectorSampler(VectorSampler const &in_that)
  virtual ~VectorSampler()

  Public Static Attributes

  static const HPS::Type staticType = HPS::Type::VectorSampler

Hello I'm HOOPSY!

HOOPSY BETA

Hello I am HOOPSY! your Docs generative AI assistant.

Ask me anything about HOOPS Visualize HPS or choose a sample question below to start a conversation:

Additional info

HOOPSY may store chats to provide and maintain the service according to OpenAI's data policy.

This feature is currently experimental. While we are continually enhancing its performance and quality, the underlying AI model may generate inaccurate or fabricated responses, especially if prompted to do so.

New Conversation
Continue generating